FlowGroup

Manages the workflow group settings, including members, positions, timeout options, and documents.

Properties

Name	Description
MessageOptions	Gets or sets the message options.
NotificationOptions	Gets or sets the push notification options.
ConflictStateEventId	Event ID for handling conflict states in the group.
Key	A unique identifier for the workflow step.
MailMessage	Gets the mail message associated with the message.
WorkflowCodeInstance	The workflow code instance associated with the flow object.
CachedDMObjects	The cached document management objects related to the flow object.
DoNotSendRequestIfProcessed	Indicates whether a request should be avoided if already processed.
NotificationCaption	Gets the notification caption associated with the message.
Positions	Retrieves the positions resolved for the workflow group members.
EmptyGroupEventId	Specifies the event ID triggered when the group is empty.
NotificationMessage	Gets the notification message associated with the message.
HideApporoverInHistory	Determines whether the approver's name is hidden in the workflow history.
AutoOpenApprovalOption	Specifies whether approvals should open automatically upon group interaction.
IsCustomMailMessage	Gets or sets a value indicating whether the mail message is custom.
MailSubject	Gets the mail subject associated with the message.
GeolocationOptions	Geolocation options for tracking workflow-related activities.
EnableSendMail	Gets or sets a value indicating whether sending mail is enabled.
TypeCode	The type code associated with the flow object.
Members	Holds the configuration for members within the group.
EventsToCheck	List of event IDs that should be checked for the workflow group.
TimeoutHour	The number of hours before a timeout occurs.
RequestIsNecessaryIfDocumentChanged	Specifies if a request is required when the document changes.
TimeoutDuration	The total timeout duration for the group.
Attachments	Gets the list of attachments associated with the message.
WebNotificationOptions	Gets or sets the web notification options.
TableObjects	List of table objects relevant to the workflow group.
TimeoutOptions	Defines the timeout settings for the group.
TimeoutDay	The number of days before a timeout occurs.
Name	Name for the workflow step.
DetailObjects	Detail objects within the workflow group.
CalculateUsingWorkingHours	Indicates whether working hours are considered for timeout calculations.
Users	Retrieves the users resolved for the workflow group members.
EnableOwnRequest	Specifies whether users can approve their own requests within this group.
Documents	List of documents associated with the workflow group.
Events	Read-only list of events associated with the workflow group.
EnablePushNotification	Gets or sets a value indicating whether push notification is enabled.
PositionGroups	Represents the position groups associated with the workflow group.
CustomMailMessage	Gets the custom mail message associated with the message.
TimeoutMinute	The number of minutes before a timeout occurs.
ShowInFlowHistory	Indicates whether this group should appear in the workflow history.
CalculateUsingHolidays	Determines whether holiday settings are considered in timeout calculations.
Caption	The caption dictionary representing localized captions for the flow object.

Constructors

Name	Description
FlowGroup(name, workflowData, workflowCodeInstance)	Constructor for the FlowGroup class. Initializes a new instance of the FlowGroup class.
FlowGroup(name, workflowData, workflowCodeInstance)	Initializes a new instance of the FlowGroup class.
FlowGroup(name,workflowData,workflowCodeInstance)	Initializes a new instance of the FlowGroup class.

Methods

Name	Description
SendRequestsCanceledWebNotification(userInfo, requestItem)	Sends a real-time notification to the user indicating that the current request has been canceled, prompting the client to close any associated open forms.
AddConstantPosition(id)	Adds a constant position to the workflow group using its ID.
ClearGroup()	Clears all members, positions, and related settings from the workflow group.
AddConstantUser(id)	Adds a constant user to the workflow group using their ID.
AddConstantUser(id, userName, userCode)	Adds a constant user to the workflow group with additional details.
Initialize()	Initializes the workflow group with default configurations.
AddAttachment(value,type)	Adds an attachment to the mail message.
RemoveDocument(flowDocument)	Removes a document from the workflow group.
IsEmpty()	Checks if the workflow group has no members or positions.
AddConstantPosition(id, positionCode, positionDescription)	Adds a constant position to the workflow group with additional details.
AddDocument(flowDocument, viewName, viewId, panelSize, allowEdit, showEvents)	Adds a document to the workflow group with various display options.
SendPushNotification(userInfo,requestItem)	Sends a push notification to a user.
AddDepartmentBasedUserGroup(departmentId, titleId)	Adds a user group based on department and title to the workflow group.
SendApprovalWebNotification(userInfo, requestItem)	Sends a web notification for approval to the specified user.
SendRequestTimedOutWebNotification(userInfo, requestItem)	Sends a real-time notification to the user indicating that the request has timed out, prompting the client to close any related open forms.
ToLiquid()	Converts the workflow group configuration into a Liquid-compatible format.
GetUserInfo(requestItem)	Retrieves user information for a given process request item.
SendMail(requestItem, userInfo)	Sends an email to a user associated with the process request.
SendWebNotification(payloadType,userInfo,requestItem)	Sends a web notification to a user.

Events

Name	Description
OnBeforeExecution(sender, args)	Occurs before the execution of the workflow step.
OnAfterExecution(sender, args)	Occurs after the execution of the workflow step.

Generic Types

Name	Description
TProperties	Generic type of properties.